lookup-tariff-codes
Mapping Fields and details
The below table has details about the fields used in lookup tariff code call requests.
| Field Name | Data Type | Restrictions | Required? | Notes |
|---|---|---|---|---|
| consignmentId | string | optional | The ID used by the client to tie back to the consignment being checked. This field is optional but User can use this field to supply a unique identification value for tracking the request and responses. Examples: barcode or tracking_id or consignment_id etc. | |
| destinationCountry | string | ANSI 2 char | required | The ANSI 2-character code for the country the item is being sent to, as defined by ISO3166 If this is missing, the 10-digit import code will be null in the response. |
| overrideTranslation | boolean | optional | Hurricane will attempt to translate any inbound product description for the purposes of matching. This translation is based on the UPU guidelines for translation. We check in English, French, destination country and additionally source country languages. If set true , the system assumes all descriptions do not require translation and will be in English. If omitted then true will be assumed. | |
| products | Array | required | At this stage there will only be 1 product per call | |
| … description | string | optional if hs6code provided otherwise required | The client description of the product | |
| … hs6code | string | optional if description provided otherwise required | The client-supplied HS6 code. If the HS6 code and description appear not to match then the HS6 code will take precedence for the call. If a code longer than 6 digits is supplied, then we will trim to 6 digits prior to processing | |
| … originatingCountry | string | ANSI 2 char | optional | The ANSI 2-character code for the country the item was produced in, as defined by ISO3166. This will only have an impact on certain import and export control codes. |
| showOptions | boolean | optional | If true Hurricane will return the top matches used for the call, in order of likelihood. If omitted then false will be assumed. | |
| showOriginalCodes | boolean | optional | When returning the 10-digit import and export codes Hurricane will pad a code less than 10 digits long (i.e. 12345678 becomes 1234567800) or trim one longer than 10 digits (12345678901 becomes 1234567890). If this is set to true then Hurricane will return two additional fields in the response that have the original length codes in them. The original codes may be 6,8,9,10,11 digits long depending on the country and their particular tariff schema. Note: these may still be 10 digits if that is all that was available. If omitted then false will be assumed. | |
| sourceCountry | string | ANSI 2 char | required | The ANSI 2-character code for the country the item is being sent from, as defined by ISO3166. If this is missing, the 10-digit export code will be null in the response. |